home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / Examples ƒ / Example / IC Headers ƒ / IC API Readme.h < prev    next >
Encoding:
Text File  |  1995-11-08  |  1.4 KB  |  34 lines  |  [TEXT/SPM ]
  1. /*
  2.     API Readme.c
  3.     
  4.     This is a summary of the routine name prefixes and how they are used.  Most of the information
  5.     comes from a table from Quinn's develop article.
  6.     
  7.     Prefix            Part of Sytem            First Parameter            GetPref Specification
  8.     
  9.     IC                Standard API            ICInstance                    ICError ICGetPref(ICInstance inst,StringPtr key,...);
  10.                     (switch glue)
  11.     
  12.     ICC                Component API            ComponentInstance            ICError ICCGetPref(ComponentInstance inst,StringPtr key,...);
  13.                     (component glue)
  14.     
  15.     ICCI                Component Internal        GlobalsHandle                ICError ICCIGetPref(GlobalsHandle inst,StringPtr key,...);
  16.     
  17.     ICR                Linked In Code            ICRRecordPtr                ICError ICRGetPref(ICRRecordPtr inst,StringPtr key,...);
  18.     
  19.     The standard API routines provide a switch between the component routines and the linked in code routines.  This should provide
  20.     a transparent interface to the Internet Config system without having to worry about the presence of the Component Manager or the
  21.     IC Component.
  22.     
  23.     The component API routines are the interface to the IC Component.  These routines are mostly glue to call the component through
  24.     the Component Manager with the proper message (for more information about components, see the references in a separate doc).
  25.     
  26.     The linked in code is the main guts for the system (the component calls the linked in code routines internally).  These routines use
  27.     the Resource Manager to access the IC config file.
  28.     
  29. */
  30.  
  31.  
  32.  
  33.     
  34.